-
Notifications
You must be signed in to change notification settings - Fork 15
Storagebox cleanup #173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Storagebox cleanup #173
Conversation
Docs Build 📝Thank you for contribution!✨ The docs for this PR have been published here: You can compare to the docs for the The docsite for this PR is also available for download as an artifact from this run: File changes:
Click to see the diff comparison.NOTE: only file modifications are shown here. New and deleted files are excluded. The diff output was truncated because it exceeded the maximum size. diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_info_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_info_module.html
index dc83775..888a071 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_info_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_info_module.html
@@ -199,6 +199,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The password for the Robot web-service user.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -208,6 +209,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The API token for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
+<p>This option will be required from community.hrobot 3.0.0 on.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -217,6 +219,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p>The username for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -264,6 +267,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-property">Action groups:</strong> <strong class="ansible-attribute-support-full">community.hrobot.api</strong>, <strong class="ansible-attribute-support-full">community.hrobot.robot</strong></p>
</div></td>
<td><div class="ansible-option-cell"><p>Use <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> or <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.api</span></code> in <code class="docutils literal notranslate"><span class="pre">module_defaults</span></code> to set defaults for this module.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> group is <strong>deprecated</strong> for this module; the module will be removed from the group in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -417,6 +421,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Total amount of MB available.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-storage-box-type-size"><span class="std std-ref"><span class="pre">storageboxes[].storage_box_type.size</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">10240000</span></code></p>
</div></td>
@@ -427,6 +432,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The amount of MB in use.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-stats-size"><span class="std std-ref"><span class="pre">storageboxes[].stats.size</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">900</span></code></p>
</div></td>
@@ -437,6 +443,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The amount of MB used by files.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-stats-size-data"><span class="std std-ref"><span class="pre">storageboxes[].stats.size_data</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">500</span></code></p>
</div></td>
@@ -447,6 +454,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The amount of MB used by snapshots.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-stats-size-snapshots"><span class="std std-ref"><span class="pre">storageboxes[].stats.size_snapshots</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">400</span></code></p>
</div></td>
@@ -457,6 +465,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether the storage box is reachable externally.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-access-settings-reachable-externally"><span class="std std-ref"><span class="pre">storageboxes[].access_settings.reachable_externally</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
</div></td>
@@ -522,6 +531,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The storage box’s login name.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-username"><span class="std std-ref"><span class="pre">storageboxes[].username</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"u12345"</span></code></p>
</div></td>
@@ -577,6 +587,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether SAMBA is active.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-access-settings-samba-enabled"><span class="std std-ref"><span class="pre">storageboxes[].access_settings.samba_enabled</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
</div></td>
@@ -651,6 +662,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether SSH is active.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-access-settings-ssh-enabled"><span class="std std-ref"><span class="pre">storageboxes[].access_settings.ssh_enabled</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
</div></td>
@@ -918,6 +930,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether WebDAV is active.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-access-settings-webdav-enabled"><span class="std std-ref"><span class="pre">storageboxes[].access_settings.webdav_enabled</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
</div></td>
@@ -928,6 +941,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Shows whether the ZFS directory is visible.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-return-storageboxes-access-settings-zfs-enabled"><span class="std std-ref"><span class="pre">storageboxes[].access_settings.zfs_enabled</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-full-info"><span class="std std-ref"><span class="pre">full_info=true</span></span></a></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">false</span></code></p>
</div></td>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_module.html
index 24c4032..95022b7 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_module.html
@@ -196,6 +196,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The password for the Robot web-service user.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -205,6 +206,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The API token for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
+<p>This option will be required from community.hrobot 3.0.0 on.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -214,6 +216,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p>The username for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -308,6 +311,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-property">Action groups:</strong> <strong class="ansible-attribute-support-full">community.hrobot.api</strong>, <strong class="ansible-attribute-support-full">community.hrobot.robot</strong></p>
</div></td>
<td><div class="ansible-option-cell"><p>Use <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> or <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.api</span></code> in <code class="docutils literal notranslate"><span class="pre">module_defaults</span></code> to set defaults for this module.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> group is <strong>deprecated</strong> for this module; the module will be removed from the group in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_set_password_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_set_password_module.html
index 11ba1f0..b650f2a 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_set_password_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_set_password_module.html
@@ -184,6 +184,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The password for the Robot web-service user.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -193,6 +194,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The API token for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
+<p>This option will be required from community.hrobot 3.0.0 on.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -202,6 +204,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p>The username for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-set-password-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -250,6 +253,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-property">Action groups:</strong> <strong class="ansible-attribute-support-full">community.hrobot.api</strong>, <strong class="ansible-attribute-support-full">community.hrobot.robot</strong></p>
</div></td>
<td><div class="ansible-option-cell"><p>Use <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> or <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.api</span></code> in <code class="docutils literal notranslate"><span class="pre">module_defaults</span></code> to set defaults for this module.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> group is <strong>deprecated</strong> for this module; the module will be removed from the group in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_snapshot_info_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_snapshot_info_module.html
index b7c3895..a72ba6f 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_snapshot_info_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_snapshot_info_module.html
@@ -184,6 +184,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The password for the Robot web-service user.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -193,6 +194,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The API token for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
+<p>This option will be required from community.hrobot 3.0.0 on.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -202,6 +204,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p>The username for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -241,6 +244,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-property">Action groups:</strong> <strong class="ansible-attribute-support-full">community.hrobot.api</strong>, <strong class="ansible-attribute-support-full">community.hrobot.robot</strong></p>
</div></td>
<td><div class="ansible-option-cell"><p>Use <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> or <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.api</span></code> in <code class="docutils literal notranslate"><span class="pre">module_defaults</span></code> to set defaults for this module.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> group is <strong>deprecated</strong> for this module; the module will be removed from the group in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -315,6 +319,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether the snapshot was created automatically.</p>
<p>Note that this is computed from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-return-snapshots-is-automatic"><span class="std std-ref"><span class="pre">snapshots[].is_automatic</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">false</span></code></p>
</div></td>
@@ -325,6 +330,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The comment for the snapshot.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-return-snapshots-description"><span class="std std-ref"><span class="pre">snapshots[].description</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">snapshot"</span></code></p>
</div></td>
@@ -355,6 +361,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The size of the Storage Box at creation time of the snapshot in MB.</p>
<p>Note that this is computed from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-return-snapshots-stats-size-filesystem"><span class="std std-ref"><span class="pre">snapshots[].stats.size_filesystem</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">12345</span></code></p>
</div></td>
@@ -403,6 +410,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The Snapshot size in MB.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-return-snapshots-stats-size"><span class="std std-ref"><span class="pre">snapshots[].stats.size</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">400</span></code></p>
</div></td>
@@ -450,6 +458,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The timestamp of snapshot in UTC.</p>
<p>Note that this is copied from <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-return-snapshots-created"><span class="std std-ref"><span class="pre">snapshots[].created</span></span></a></code> in case <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> is specified.</p>
+<p><strong>This return value is deprecated and will be removed from community.hrobot 3.0.0.</strong> If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"2025-01-21T13:40:38+00:00"</span></code></p>
</div></td>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_snapshot_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_snapshot_module.html
index 58faefe..c004749 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_snapshot_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_snapshot_module.html
@@ -184,6 +184,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The password for the Robot web-service user.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -193,6 +194,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The API token for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
+<p>This option will be required from community.hrobot 3.0.0 on.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -202,6 +204,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p>The username for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -269,6 +272,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-property">Action groups:</strong> <strong class="ansible-attribute-support-full">community.hrobot.api</strong>, <strong class="ansible-attribute-support-full">community.hrobot.robot</strong></p>
</div></td>
<td><div class="ansible-option-cell"><p>Use <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> or <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.api</span></code> in <code class="docutils literal notranslate"><span class="pre">module_defaults</span></code> to set defaults for this module.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">group/community.hrobot.robot</span></code> group is <strong>deprecated</strong> for this module; the module will be removed from the group in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_snapshot_plan_info_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_snapshot_plan_info_module.html
index a6861be..17120d8 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/storagebox_snapshot_plan_info_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/storagebox_snapshot_plan_info_module.html
@@ -184,6 +184,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The password for the Robot web-service user.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> must not be specified.</p>
+<p>This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -193,6 +194,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
<td><div class="ansible-option-cell"><p>The API token for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
+<p>This option will be required from community.hrobot 3.0.0 on.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -202,6 +204,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<td><div class="ansible-option-cell"><p>The username for the Robot web-service user.</p>
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-token"><span class="std std-ref"><span class="pre">hetzner_token</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> must be specified.</p>
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-user"><span class="std std-ref"><span class="pre">hetzner_user</span></span></a></strong></code> is specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-password"><span class="std std-ref"><span class="pre">hetzner_password</span></span></a></strong></code> must also be specified, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-hrobot-storagebox-snapshot-plan-info-module-parameter-hetzner-token"><span clas |
…_token not being required; deprecate membership of robot action group.
974862c
to
fe60d91
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #173 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 60 61 +1
Lines 4617 4076 -541
Branches 517 439 -78
==========================================
- Hits 4617 4076 -541 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
3c4a62e
to
3eebb84
Compare
The last TODO item is blocked by ansible/ansible#85614; I might just move it to a follow-up PR and first get the others merged (and released). |
Hmm, according to https://robot.hetzner.com/doc/webservice/en.html#get-storagebox the old API is still there for some specific storage boxes. So let's wait with merging this until the API has been fully removed. |
9f94fd7
to
b9d81d4
Compare
SUMMARY
hetzner_user
/hetzner_pass
;hetzner_token
will be required in the future;robot
action group;ISSUE TYPE
COMPONENT NAME
storagebox* modules